package com.project.myPackage.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import com.project.myPackage.common.JacksonObjectMapper;
import io.swagger.annotations.*;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.List;

@Slf4j
@Configuration
@EnableSwagger2
@EnableKnife4j
public class WebMvcConfig extends WebMvcConfigurationSupport {

    /**
     * 设置静态资源映射
     * @param registry
     */
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        log.info("开始进行静态资源映射...");
        registry.addResourceHandler("/backend/**").addResourceLocations("classpath:/backend/");
        registry.addResourceHandler("/front/**").addResourceLocations("classpath:/front/");
        //扫描static下的所有html页面
        registry.addResourceHandler("classpath:/static/*.html");
        //扫描static下的所有资源
        registry.addResourceHandler("/static/**");
        // 系统自动帮忙生成这doc.html页面用于展示我们的接口信息，我们需要将他们放行
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

    @Bean(value = "createRestApi")
    public Docket createRestApi() {
        // 文档类型
        // （返回一个文档类型Docket，下面是返回文档的类型，基本为固定形式，除了basePackage，书写你的Controller包的位置）
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //注明Controller的文件位置
                .apis(RequestHandlerSelectors.basePackage("com.project.myPackage.controller"))
                .paths(PathSelectors.any())
                .build();
    }
//  访问地址：  http://127.0.0.1:3000/doc.html
    private ApiInfo apiInfo() {
        // 描述文档内容
        return new ApiInfoBuilder()
                .title("项目标题")
                .version("1.0")
                .description("接口文档")
                .build();
    }

    /**
     * 扩展mvc框架的消息转换器
     * @param converters
     */
    @Override
    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        log.info("扩展消息转换器...");
        //创建消息转换器对象
        MappingJackson2HttpMessageConverter messageConverter = new MappingJackson2HttpMessageConverter();
        //设置对象转换器，底层使用Jackson将Java对象转为json
        messageConverter.setObjectMapper(new JacksonObjectMapper());
        //将上面的消息转换器对象追加到mvc框架的转换器集合中
        converters.add(0,messageConverter);
    }
}

//文档注释示例
/**
 // 这里仅给出文档注释（不给出示例）

 // 用于请求的类上，表示对类的说明（Controller）
 @Api(tags = "")

 // 用于类上，通常是实体类，表示一个返回数据的信息（domain，Result）
 @ApiModel(value = "")

 // 用于属性上，描述相应类的属性（name）
 @ApiModelProperty(value = "")

 // 用于请求的方法上，说明方法的用途，作用
 @ApiOperation(value = "")

 // 用于请求的方法上，表示一组参数说明
 @ApiImplicitParams({@ApiImplicitParam,@ApiImplicitParam})

 // 用于请求的方法上，表示单个参数说明
 @ApiImplicitParam(name = "",value = "",required = true/false)
 */
